UpdateAgreement
The UpdateAgreement web service
XML- or JSON-based information exchange systems that use the Internet for direct application-to-application interaction. These systems can include programs, objects, messages, or documents. enables an external client system to update the Agreement In the Cloud Monetisation Platform, the entity that holds the instructions for generating the bills for one or more subscriptions. including the addresses and how often the bill is generated. details for a given Agreement Number.
This web service should be used in conjunction with the Query Agreement web service.
The user A person with the capability to log in to the CMP GUI software, such as a customer service advisor or agent. must pass in a valid CMP Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. Agreement Number and update the Agreement details.
Invalid requests are rejected with an error message.
UpdateAgreement Request
The UpdateAgreement tag instructs the Agreement Service to update the Agreement details. This request contains the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
UpdateAgreementData |
Container |
See UpdateAgreementData Request Container for details |
Mandatory |
UpdateAgreementData Request Container
The UpdateAgreementData request container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
ExternalReference |
String69 |
The client may use this identifier to correlate the request and the response. |
Optional |
|
AgreementNumber |
Integer8 |
The unique system generated reference number for the Agreement. |
Mandatory |
|
UpdateAgreementBasic |
Container |
See UpdateAgreementBasic Request Container for details. |
Optional |
|
UpdateContractAndSales (Deprecated) |
Container |
See UpdateContractAndSales Request Container for details. |
Optional |
|
UpdateInvoiceControl |
Container |
See UpdateInvoiceControl Request Container for details. |
Optional |
|
AuditRecord |
Container |
See AuditRecord Request Container for details. |
Optional |
UpdateAgreementBasic Request Container
The UpdateAgreementBasic request container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
InvoiceFrequency |
Container
|
This indicates how often invoices are produced. Choice of:
|
Optional |
|
InvoiceConsolidationLevel |
String - Enumeration |
A single consolidated invoice can be produced at a chosen level within the billing hierarchy. Choice of:
|
Optional |
|
InvoiceAddress |
String |
This indicates to which address invoices are mailed. |
Optional |
|
BillingMedia |
String6 |
The format in which the invoice is printed e.g. A4 paper. |
Optional |
|
AddressNumber |
Integer 0-99999999 |
This details the Account level delivery address number which is one of the several delivery addresses available. |
Optional |
|
AttachSubscriptionsOnCreation |
Boolean |
If set to True, this allows contract information to be used as the default by CMP Subscriptions linked to this Agreement. |
Optional |
|
LastAmendedDate |
dateTime |
YYYY-MM-DDThh:mm:ssZ |
Mandatory |
UpdateContractAndSales Request Container
The UpdateContractAndSales request container has been deprecated. An error message is returned for requests that specify this container.
UpdateInvoiceControl Request Container
The UpdateInvoiceControl request container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
BillingCycle |
Integer 1-31 |
Day of the Month on which the bill will be produced. Range 1-31 - CMP compensates for months with fewer than 31 days. |
Optional |
|
OverrideBillingCycle |
Boolean |
If set to True, the day on which the bill is produced can be overridden if more than one billing cycle date is available. For example, the date can be amended to fall in line with the day a customer receives their salary. |
Optional |
|
FirstInvoiceOnCycle |
Boolean |
If set to True, Invoice Production will be deferred to the next cyclical billing date (if connection occurs after the cycle date within the current month). |
Optional |
|
FinalInvoiceOnCycle |
Boolean |
The final Invoice Production is usually deferred to allow all receipt of all possible late roamed usage information from the network. If set to True, this deferral is prevented and the final bill is produced on the cycle date. |
Optional |
|
NextExpectedInvoiceDate |
Date |
The cycle date on which the very next invoice will be produced. YYYY-MM-DDZ |
Optional |
|
LastAmendedDate |
dateTime |
YYYY-MM-DDThh:mm:ssZ |
Mandatory |
AuditRecord Request Container
The AuditRecord request container has the following elements:
|
UserID |
String10 |
User ID associated with the profile. This is the ID which the calling program adds to the records that are created. |
Mandatory |
|
Program |
String10 |
The Program Name should be hard coded in the calling application to uniquely identify that application. |
Mandatory |
UpdateAgreement Response
The UpdateAgreement response is the response to the UpdateAgreement Request. This contains the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
AgreementNumber |
Integer8 |
Returned unmodified in the response. The client may use this identifier to correlate the request and the response. |
Mandatory |
|
ExternalReference |
String69 |
Returned unmodified in the response. The client may use this identifier to correlate the request and the response. |
Optional |